<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Kinetis Bootloader: usb_msd_state_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Kinetis Bootloader
   &#160;<span id="projectnumber">2.0.0</span>
   </div>
   <div id="projectbrief">Common bootloader for Kinetis devices</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Introduction</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('structusb__msd__state__t.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">usb_msd_state_t Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>State information for the USB MSD peripheral.  
 <a href="structusb__msd__state__t.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="msc__disk_8h_source.html">msc_disk.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a7354b2a4f1363f97ed720e99705a14f4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7354b2a4f1363f97ed720e99705a14f4"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>start_app</b></td></tr>
<tr class="separator:a7354b2a4f1363f97ed720e99705a14f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c740139cf62c8b615e8f8d22cf73d3a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4c740139cf62c8b615e8f8d22cf73d3a"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structusb__msd__state__t.html#a4c740139cf62c8b615e8f8d22cf73d3a">buffer</a> [<a class="el" href="group__usb__msd__disk.html#gga13544a8c09d3e18b6c586e8e5cad891cad61c036248234112b347132172a29c56">kDiskSectorSize</a>]</td></tr>
<tr class="memdesc:a4c740139cf62c8b615e8f8d22cf73d3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic buffer. <br /></td></tr>
<tr class="separator:a4c740139cf62c8b615e8f8d22cf73d3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03e4d07b25484e5eb37a8ac56d98e64a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03e4d07b25484e5eb37a8ac56d98e64a"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structusb__msd__state__t.html#a03e4d07b25484e5eb37a8ac56d98e64a">sbBuffer</a> [<a class="el" href="group__usb__msd__disk.html#gga13544a8c09d3e18b6c586e8e5cad891cad61c036248234112b347132172a29c56">kDiskSectorSize</a>]</td></tr>
<tr class="memdesc:a03e4d07b25484e5eb37a8ac56d98e64a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Buffer to hold SB file sectors. <br /></td></tr>
<tr class="separator:a03e4d07b25484e5eb37a8ac56d98e64a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ba1486f6de25f9207b69f95c2fafc3d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2ba1486f6de25f9207b69f95c2fafc3d"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>isDiskLocked</b></td></tr>
<tr class="separator:a2ba1486f6de25f9207b69f95c2fafc3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea82e33598f5f040704ecc21c7fa917e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea82e33598f5f040704ecc21c7fa917e"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>read_write_error</b></td></tr>
<tr class="separator:aea82e33598f5f040704ecc21c7fa917e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f90820d1554c5f2d1ce29bc20689866"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f90820d1554c5f2d1ce29bc20689866"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structusb__msd__state__t.html#a1f90820d1554c5f2d1ce29bc20689866">isActive</a></td></tr>
<tr class="memdesc:a1f90820d1554c5f2d1ce29bc20689866"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set to true when the first SB file is transferred. <br /></td></tr>
<tr class="separator:a1f90820d1554c5f2d1ce29bc20689866"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6e466ae3a9a982c407b1a22123d0cdf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad6e466ae3a9a982c407b1a22123d0cdf"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structusb__msd__state__t.html#ad6e466ae3a9a982c407b1a22123d0cdf">isTransferring</a></td></tr>
<tr class="memdesc:ad6e466ae3a9a982c407b1a22123d0cdf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether an SB file transfer has been started. <br /></td></tr>
<tr class="separator:ad6e466ae3a9a982c407b1a22123d0cdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2192544f0e6a4391207356b144054a36"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2192544f0e6a4391207356b144054a36"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>sbLoaderStatus</b></td></tr>
<tr class="separator:a2192544f0e6a4391207356b144054a36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a5786905ddcae53b55003bbe752076f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a5786905ddcae53b55003bbe752076f"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structusb__msd__state__t.html#a8a5786905ddcae53b55003bbe752076f">isProcessing</a></td></tr>
<tr class="memdesc:a8a5786905ddcae53b55003bbe752076f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set to true while the SB file is being processed. <br /></td></tr>
<tr class="separator:a8a5786905ddcae53b55003bbe752076f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a225c2914ef8607b63bb9ee1add219093"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a225c2914ef8607b63bb9ee1add219093"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structusb__msd__state__t.html#a225c2914ef8607b63bb9ee1add219093">isReceivePending</a></td></tr>
<tr class="memdesc:a225c2914ef8607b63bb9ee1add219093"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether a sector write is being held off until a buffer is free. <br /></td></tr>
<tr class="separator:a225c2914ef8607b63bb9ee1add219093"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3683d3d2c9cc6478ede8e49f8e112dfb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3683d3d2c9cc6478ede8e49f8e112dfb"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structusb__msd__state__t.html#a3683d3d2c9cc6478ede8e49f8e112dfb">infoFileLength</a></td></tr>
<tr class="memdesc:a3683d3d2c9cc6478ede8e49f8e112dfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size in bytes of the info.txt file. <br /></td></tr>
<tr class="separator:a3683d3d2c9cc6478ede8e49f8e112dfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19397f5c186757bbf4972112a429d1dc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a19397f5c186757bbf4972112a429d1dc"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structusb__msd__state__t.html#a19397f5c186757bbf4972112a429d1dc">nextSector</a></td></tr>
<tr class="memdesc:a19397f5c186757bbf4972112a429d1dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">The next expected sector write for the SB file transfer. <br /></td></tr>
<tr class="separator:a19397f5c186757bbf4972112a429d1dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e1438e628287ef1984fa5aa84e38d59"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6e1438e628287ef1984fa5aa84e38d59"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structusb__msd__state__t.html#a6e1438e628287ef1984fa5aa84e38d59">remainingFileLength</a></td></tr>
<tr class="memdesc:a6e1438e628287ef1984fa5aa84e38d59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total length in bytes of the SB file being transferred. <br /></td></tr>
<tr class="separator:a6e1438e628287ef1984fa5aa84e38d59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bd1a93988c310990fdd02b2ffb9243d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6bd1a93988c310990fdd02b2ffb9243d"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structusb__msd__state__t.html#a6bd1a93988c310990fdd02b2ffb9243d">dataBytesAvailable</a></td></tr>
<tr class="memdesc:a6bd1a93988c310990fdd02b2ffb9243d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of bytes available in sectorBuffer. <br /></td></tr>
<tr class="separator:a6bd1a93988c310990fdd02b2ffb9243d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ed86356331cf97f998bb9974dba8c5e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ed86356331cf97f998bb9974dba8c5e"></a>
sb_transfer_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structusb__msd__state__t.html#a3ed86356331cf97f998bb9974dba8c5e">transferStatus</a></td></tr>
<tr class="memdesc:a3ed86356331cf97f998bb9974dba8c5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Status to present in the status.txt file. <br /></td></tr>
<tr class="separator:a3ed86356331cf97f998bb9974dba8c5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa0d662293030b37726d5c33aab33f2d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa0d662293030b37726d5c33aab33f2d"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structusb__msd__state__t.html#aaa0d662293030b37726d5c33aab33f2d">isLoaderInited</a></td></tr>
<tr class="memdesc:aaa0d662293030b37726d5c33aab33f2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flag to indicate that the SB loader has been initialized. <br /></td></tr>
<tr class="separator:aaa0d662293030b37726d5c33aab33f2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>State information for the USB MSD peripheral. </p>
<p>The sector buffers come first so they will be word aligned. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a4c740139cf62c8b615e8f8d22cf73d3a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t buffer</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Generic buffer. </p>

</div>
</div>
<a class="anchor" id="a6bd1a93988c310990fdd02b2ffb9243d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t dataBytesAvailable</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Number of bytes available in sectorBuffer. </p>

</div>
</div>
<a class="anchor" id="a3683d3d2c9cc6478ede8e49f8e112dfb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t infoFileLength</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Size in bytes of the info.txt file. </p>

</div>
</div>
<a class="anchor" id="a1f90820d1554c5f2d1ce29bc20689866"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t isActive</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set to true when the first SB file is transferred. </p>

</div>
</div>
<a class="anchor" id="a2ba1486f6de25f9207b69f95c2fafc3d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t isDiskLocked</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="aaa0d662293030b37726d5c33aab33f2d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t isLoaderInited</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Flag to indicate that the SB loader has been initialized. </p>

</div>
</div>
<a class="anchor" id="a8a5786905ddcae53b55003bbe752076f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t isProcessing</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set to true while the SB file is being processed. </p>

</div>
</div>
<a class="anchor" id="a225c2914ef8607b63bb9ee1add219093"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t isReceivePending</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Whether a sector write is being held off until a buffer is free. </p>

</div>
</div>
<a class="anchor" id="ad6e466ae3a9a982c407b1a22123d0cdf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t isTransferring</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Whether an SB file transfer has been started. </p>

</div>
</div>
<a class="anchor" id="a19397f5c186757bbf4972112a429d1dc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t nextSector</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The next expected sector write for the SB file transfer. </p>

</div>
</div>
<a class="anchor" id="aea82e33598f5f040704ecc21c7fa917e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t read_write_error</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a6e1438e628287ef1984fa5aa84e38d59"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t remainingFileLength</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Total length in bytes of the SB file being transferred. </p>

</div>
</div>
<a class="anchor" id="a03e4d07b25484e5eb37a8ac56d98e64a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t sbBuffer</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Buffer to hold SB file sectors. </p>

</div>
</div>
<a class="anchor" id="a2192544f0e6a4391207356b144054a36"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t sbLoaderStatus</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a7354b2a4f1363f97ed720e99705a14f4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t start_app</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a3ed86356331cf97f998bb9974dba8c5e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sb_transfer_status_t transferStatus</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Status to present in the status.txt file. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li><a class="el" href="msc__disk_8h_source.html">msc_disk.h</a></li>
<li>disk.c</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="structusb__msd__state__t.html">usb_msd_state_t</a></li>
    <li class="footer">Generated on Mon Mar 7 2016 16:48:24 for Kinetis Bootloader by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
